Get Dial Plan Contents for SIP Connection

The Get Dial Plan Contents for SIP Connection request retrieves a list of numbers contained in a specific dial plan for a specific SIP Connection (Site Location).

URI

Copy

{{baseUrl}}/api/v2/customer/{{customerId}}/sitelocation/{{siteLocationId}}/dialplan/{dialplanId}

HTTP Method

GET

Request Parameters

Parameters	Type	Description
customerId	string($uuid)	Unique customer 'Id' created when customer is added. Extract this value from Get Services Brief Details (V3) request.
sitelocationId	string($uuid)	Unique Id for SIP Connection (Site Location). For services with a single site, this value is identical to Customer 'Id' above. Extract this value from Get Services Brief Details (V3) request.
dialplanId	string($uuid)	The dial plan name. For example, CustDialPlan.

Example Response

Copy

{
    "dialPlanId": "CustDialPlan",
    "ruleDTO": [
        {
            "name": "GSBFZUBGHWOFI",
            "prefix": "+97239753000",
            "tag": "sandbox1.audiocodes.be"
        },
        {
            "name": "GSBFZUBGHWOFI",
            "prefix": "+97239753001",
            "tag": "sandbox1.audiocodes.be"
        },
        {
            "name": "GSBFZUBGHWOFI",
            "prefix": "+97239753002",
            "tag": "sandbox1.audiocodes.be"
        },
        {
            "name": "GSBFZUBGHWOFI",
            "prefix": "+97239753003",
            "tag": "sandbox1.audiocodes.be"
        }
    ]
}

HTTP Responses

■

200 OK

Parameter	Type	Description
dialPlanId	string	The Dial plan name.
RuleDTO
name	string	The name of the SIP Connection according to 'sitelocationGuid' above.
prefix	string	The calling prefixes to add for users for this SIP Connection. For example "{{+019123854567}}".
tag	string	The Derived Trunk FQDN of the SBC device used to manage calls for this site location. For example, sandbox1.audiocodes.be If a number is added with a tag that is not an AudioCodes SBC PSTN gateway, then for the purpose of User licensing calculations, its counted as a Service Number license factor. For more information, see User Licenses.